Skip to content

(cdocs) Update Cdocs#35755

Merged
hestonhoffman merged 11 commits intomasterfrom
heston/cdocs-glossary
Apr 20, 2026
Merged

(cdocs) Update Cdocs#35755
hestonhoffman merged 11 commits intomasterfrom
heston/cdocs-glossary

Conversation

@hestonhoffman
Copy link
Copy Markdown
Contributor

@hestonhoffman hestonhoffman commented Apr 3, 2026

What does this PR do? What is the motivation?

Releases CDOCS 3.1 with support for glossary tooltips, ui tags, and Author Console improvements.

In addition to relevant playwright tests, this PR cleans up some existing glossary files that would have caused issues.

Note: You'll notice some of these glossary files have pretty weird names. I'm going to go through and rename the ones with weird symbols/spaces etc. I think this is just a bug waiting to happen.

Merge instructions

Merge readiness:

  • Ready for merge

@hestonhoffman hestonhoffman requested review from a team as code owners April 3, 2026 20:23
@hestonhoffman hestonhoffman added the WORK IN PROGRESS No review needed, it's a wip ;) label Apr 3, 2026
@hestonhoffman hestonhoffman requested a review from a team as a code owner April 3, 2026 20:23
@hestonhoffman hestonhoffman added the Do Not Merge Just do not merge this PR :) label Apr 3, 2026
@github-actions github-actions Bot added the cdocs label Apr 3, 2026
@hestonhoffman hestonhoffman requested a review from a team as a code owner April 17, 2026 21:01
@hestonhoffman hestonhoffman changed the title (cdocs) Glossary tooltips (cdocs) Update Cdocs Apr 17, 2026
### Caveats / follow-ups

- **Not-found path uncovered.** English throws at compile; the `return term` branch in `glossaryTooltip.js` is only reachable for non-English pages. If coverage matters, either relax the English throw in the cdocs tag or add a parallel non-English test page — neither is in scope here.
- **Casing on SNMP looks wrong.** `toTitleCase` turns `Simple Network Management Protocol (SNMP)` into `Simple Network Management Protocol (snmp)` — it loses the caps on `SNMP` entirely. The spec asserts the actual output, but this is worth flagging to whoever owns the tag — it may be a latent bug. No newline at end of file
Copy link
Copy Markdown
Contributor Author

@hestonhoffman hestonhoffman Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I noticed this in testing and decided not to fix it. Realistically, I doubt it will come up much. Most of the time with abbreviations like this, sentence case will already be baked in to the glossary term title. It's also the way this already works in prod, so no major loss there.

Comment thread content/en/dd_e2e/cdocs/components/glossary_tooltip.mdoc.md Outdated
hestonhoffman and others added 2 commits April 20, 2026 12:36
…6133)

* Revert change that broke e2e tests

* Bump Cdocs version

* Add e2e tests for the author console

* Take the mask off the snapshots

* Add snapshot

* Bump Cdocs to the latest

* Add e2e tests and snippet for the ui tag

* Update test index
@hestonhoffman hestonhoffman removed WORK IN PROGRESS No review needed, it's a wip ;) Do Not Merge Just do not merge this PR :) labels Apr 20, 2026
@hestonhoffman hestonhoffman merged commit 165add1 into master Apr 20, 2026
18 of 22 checks passed
@hestonhoffman hestonhoffman deleted the heston/cdocs-glossary branch April 20, 2026 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants